python-codeplex-scraper
=======================

This is a simple, lightweight (and fragile) web scraper for CodePlex. It allows
you to retrieve public information for users and projects.


Features
--------

Given a *username*, this project lets you retrieve the following information
for a person:

* projects in which they are a coordinator, editor, or developer
* projects which they've forked

Given a *project url* name (this thing: *projecturl*.codeplex.com), find the
following information:

* The number of forks for the project
* The number of followers of the project
* The project's rating
* The project's team, includeing coordinators, developers, and editors

Examples
--------

Get information for a user::

    >>> from codeplex import user
    >>> user.get('bkmontgomery')
    {
        'projects': [
            {
                'name': 'python-codeplex-scraper',
                'url':  'http://pythocodeplexscraper.codeplex.com/',
                'role': 'coordinator',
            },

        ],
        'forks': [],
    }

Get information for a project::

    >>> from codeplex import project
    >>> project.get('pythocodeplexscraper')
    {
        'downloads': 0,
        'followers': 0,
        'rating': 0,
        'team': {
            'coordinators': [
                {
                    'url': 'http://www.codeplex.com/site/users/view/bkmontgomery',
                    'username': 'bkmontgomery',
                },
            ],
            'editors': []
            'developers': []
        }
    }

Requirements
------------

This library requires ``requests``, ``beautifulsoup4``, and -- if you want to
run the tests -- ``nose`` and ``mock``.

See the ``requirements.txt``.

License
-------

This code is distributed under the terms of the MIT license. See the
``LICENSE`` file.


Feedback/Bug Reports
--------------------

Please submit any bug reports or feature requests to the
`CodePlex Issue Tracker <https://pythocodeplexscraper.codeplex.com/workitem/list/basic>`_.

